import InstallCommands from "@site/src/components/install";

# Touca CLI

Touca CLI helps you run tests, manage your local test results and submit them to
the Touca server.

## Installing

Touca CLI is part of the Touca Python SDK. It is available
[on PyPI](https://pypi.org/project/touca) and can be installed with `pip` or
[Homebrew](https://brew.sh).

<InstallCommands />

## Supported Commands

Touca CLI supports the following commands:

| Command                                                  | Description                                 |
| -------------------------------------------------------- | ------------------------------------------- |
| [`touca help`](#getting-help)                            | Learn how to use different commands         |
| [`touca config`](/cli/config)                            | Manage your active configuration profile    |
| [`touca profile`](/cli/config#configuration-profiles)    | Create and manage configuration profiles    |
| [`touca login`](/cli/test#setting-api-credentials)       | Set API credentials from the CLI            |
| [`touca check`](/cli/test#capturing-files)               | Submit external test output to Touca server |
| [`touca test`](/cli/test/#running-tests-locally)         | Run your Touca tests                        |
| [`touca results`](/cli/results)                          | Manage local test results                   |
| [`touca server`](/cli/server)                            | Install and manage your Touca server        |
| [`touca plugin`](/cli/plugins)                           | Install and manage custom CLI plugins       |
| [`touca run`](/cli/test#running-tests-on-a-test-machine) | Run tests on a dedicated test server        |
| [`touca version`](#checking-the-cli-version)             | Check your Touca CLI version                |

## Getting Help

You can run `touca help` to get this list. You can also use `help` with any
subcommand to learn about its supported options and arguments.

## Checking the CLI Version

You can run `touca version` to check what version of Touca CLI you are using.
This command prints a warning if the version of your CLI is different from the
latest available version.
